Share via


az ml computetarget create

Note

This reference is part of the azure-cli-ml extension for the Azure CLI (version 2.0.28 or higher). The extension will automatically install the first time you run an az ml computetarget create command. Learn more about extensions.

Create a compute target (aks or amlcompute or computeinstance).

Commands

Name Description Type Status
az ml computetarget create aks

Create an AKS compute target.

Extension GA
az ml computetarget create amlcompute

Create an AzureML compute target.

Extension GA
az ml computetarget create computeinstance

Create an AzureML compute instance target.

Extension GA
az ml computetarget create datafactory

Create a data factory compute target.

Extension GA

az ml computetarget create aks

Create an AKS compute target.

az ml computetarget create aks --name
                               [--agent-count]
                               [--cluster-purpose]
                               [--dns-service-ip]
                               [--docker-bridge-cidr]
                               [--load-balancer-subnet]
                               [--load-balancer-type]
                               [--location]
                               [--no-wait]
                               [--path]
                               [--resource-group]
                               [--service-cidr]
                               [--ssl-cert-file]
                               [--ssl-cname]
                               [--ssl-key-file]
                               [--ssl-leaf-domain-label]
                               [--ssl-overwrite-domain]
                               [--subnet-name]
                               [--subscription-id]
                               [--vm-size]
                               [--vnet-name]
                               [--vnet-resourcegroup-name]
                               [--workspace-name]
                               [-v]

Required Parameters

--name -n

Name of compute target to provision.

Optional Parameters

--agent-count -a

Number of agents to provision with the AKS cluster. Default: 3.

--cluster-purpose

Targeted purpose of the cluster. This is used when provisioning AzureML components to ensure the desired level of fault-tolerance and QoS. Accepted values are "FastProd" and "DevTest". Further detail of the use cases can be found here: https://aka.ms/azureml-create-new-aks-cluster.

--dns-service-ip

Containers DNS server IP address.

--docker-bridge-cidr

A CIDR notation IP for Docker bridge.

--load-balancer-subnet

You can specify subnet for the AKS cluster when Internal Load Balancer is used as load balancer type. Default is "aks-subnet".

--load-balancer-type

You can create an AKS cluster with either Public IP or Internal Load Balancer. Accepted values are "PublicIp" and "InternalLoadBalancer". Default is "PublicIp".

--location -l

Location to provision cluster in. If not specified, will default to workspace location.

--no-wait

Flag to not wait for asynchronous calls.

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--service-cidr

A CIDR notation IP range from which to assign service cluster IPs.

--ssl-cert-file

Cert pem file to use for SSL validation. If provided, must also provide cname and key pem file.

--ssl-cname

Cname to use for SSL validation. If provided, must also provide cert and key pem files.

--ssl-key-file

Key pem file to use for SSL validation. If provided, must also provide cname and cert pem file.

--ssl-leaf-domain-label

Leaf domain label to use for the auto generated certificate.

--ssl-overwrite-domain

When set overwrites the existing leaf domain label.

--subnet-name

Name of the subnet inside the vnet.

--subscription-id

Specifies the subscription Id.

--vm-size -s

VM size to use for the compute target. A full list of options can be found here: https://aka.ms/azureml-aks-details Default: Standard_D3_v2.

--vnet-name

Name of the virtual network.

--vnet-resourcegroup-name

Name of the resource group where the virtual network is located.

--workspace-name -w

Name of the workspace to create this compute target under.

-v

Verbosity flag.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml computetarget create amlcompute

Create an AzureML compute target.

az ml computetarget create amlcompute --max-nodes
                                      --name
                                      --vm-size
                                      [--admin-user-password]
                                      [--admin-user-ssh-key]
                                      [--admin-username]
                                      [--assign-identity]
                                      [--description]
                                      [--enable-node-public-ip]
                                      [--idle-seconds-before-scaledown]
                                      [--location]
                                      [--min-nodes]
                                      [--no-wait]
                                      [--path]
                                      [--remote-login-port-public-access]
                                      [--resource-group]
                                      [--subnet-name]
                                      [--subscription-id]
                                      [--tag]
                                      [--vm-priority]
                                      [--vnet-name]
                                      [--vnet-resourcegroup-name]
                                      [--workspace-name]
                                      [-v]

Required Parameters

--max-nodes

Maximum number of nodes to use. Default: 4.

--name -n

Name of compute target to provision.

--vm-size -s

VM size to use for the compute target. More details can be found here: https://aka.ms/azureml-vm-details Default: Standard_NC6.

Optional Parameters

--admin-user-password

Password of the administrator user account.

--admin-user-ssh-key

SSH public key of the administrator user account.

--admin-username

Name of the administrator user account which can be used to SSH into nodes.

--assign-identity

Use '[system]' to set a system assigned identity else input resource IDs separated by commas (ie 'ResourceID1,ResourceID2') to set user assigned identities.

--description

Description of the compute target.

--enable-node-public-ip

Enable Node Public IP.

Default value: True
--idle-seconds-before-scaledown

Node idle time in seconds before scaling down the cluster.

Default value: 1800
--location -l

Location to provision cluster in. If not specified, will default to workspace location.

--min-nodes

Minimum number of nodes to use. Default: 0.

--no-wait

Flag to not wait for asynchronous calls.

--path

Path to a project folder. Default: current directory.

--remote-login-port-public-access

State of the public SSH port. Possible values are: Enabled or Disabled.

--resource-group -g

Resource group corresponding to the provided workspace.

--subnet-name

Name of the subnet inside the vnet.

--subscription-id

Specifies the subscription Id.

--tag

Key/value tag to add (e.g. key=value ). Multiple tags can be specified with multiple --tag options.

Default value: []
--vm-priority -p

VM priority to use for the compute target. (Options are 'dedicated', 'lowpriority') Default: dedicated.

--vnet-name

Name of the virtual network.

--vnet-resourcegroup-name

Name of the resource group where the virtual network is located.

--workspace-name -w

Name of the workspace to create this compute target under.

-v

Verbosity flag.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml computetarget create computeinstance

Create an AzureML compute instance target.

az ml computetarget create computeinstance --name
                                           --vm-size
                                           [--admin-user-ssh-public-key]
                                           [--description]
                                           [--no-wait]
                                           [--path]
                                           [--resource-group]
                                           [--ssh-public-access]
                                           [--subnet-name]
                                           [--subscription-id]
                                           [--tag]
                                           [--user-object-id]
                                           [--user-tenant-id]
                                           [--vnet-name]
                                           [--vnet-resourcegroup-name]
                                           [--workspace-name]
                                           [-v]

Required Parameters

--name -n

Name of compute instance to create.

--vm-size -s

VM size to use for the compute target. More details can be found here: https://aka.ms/azureml-vm-details Default: Standard_NC6.

Optional Parameters

--admin-user-ssh-public-key

SSH public key of the administrator user account.

--description

Description of the compute target.

--no-wait

Flag to not wait for asynchronous calls.

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--ssh-public-access

State of the public SSH port. Possible values are: True or False.

--subnet-name

Name of the subnet inside the vnet.

--subscription-id

Specifies the subscription Id.

--tag

Key/value tag to add (e.g. key=value ). Multiple tags can be specified with multiple --tag options.

Default value: []
--user-object-id

The AAD Object ID of the assigned user of this compute instance (preview).

--user-tenant-id

The AAD Tenant ID of the assigned user of this compute instance (preview).

--vnet-name

Name of the virtual network.

--vnet-resourcegroup-name

Name of the resource group where the virtual network is located.

--workspace-name -w

Name of the workspace to create this compute target under.

-v

Verbosity flag.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml computetarget create datafactory

Create a data factory compute target.

az ml computetarget create datafactory --name
                                       [--location]
                                       [--no-wait]
                                       [--path]
                                       [--resource-group]
                                       [--subscription-id]
                                       [--workspace-name]
                                       [-v]

Required Parameters

--name -n

Name of compute target to provision.

Optional Parameters

--location -l

Location to provision cluster in. If not specified, will default to workspace location.

--no-wait

Flag to not wait for asynchronous calls.

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Name of the workspace to create this compute target under.

-v

Verbosity flag.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.